feat(save-user-data): create a user data abstract class COMPASS-9543 #7103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the existing UserData implementation into an abstract IUserData base class with a concrete FileUserData, and updates all storage consumers to use the new API.
- Introduces
IUserData(abstract) andFileUserDataincompass-user-data - Updates storage modules (queries, pipelines, connections, preferences, history, data modeling, atlas service) to replace
UserDatawithFileUserData - Adjusts tests and exports to align with the new types
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/my-queries-storage/src/compass-query-storage.ts | Swap to IUserData/FileUserData, adjust methods and signatures |
| packages/my-queries-storage/src/compass-pipeline-storage.ts | Replace UserData with FileUserData |
| packages/connection-storage/src/compass-main-connection-storage.ts | Replace UserData with FileUserData |
| packages/compass-user-data/src/user-data.ts | Extract IUserData, implement FileUserData, update options |
| packages/compass-user-data/src/user-data.spec.ts | Update tests to use FileUserData and its options |
| packages/compass-user-data/src/index.ts | Export IUserData and FileUserData instead of UserData |
| packages/compass-shell/src/modules/history-storage.ts | Swap UserData import for FileUserData |
| packages/compass-preferences-model/src/user-storage.ts | Replace UserData with FileUserData |
| packages/compass-preferences-model/src/preferences-persistent-storage.ts | Swap to FileUserData for preferences storage |
| packages/compass-data-modeling/src/services/data-model-storage-electron.tsx | Replace UserData with FileUserData |
| packages/compass-data-modeling/src/components/diagram-card.spec.tsx | Relax test assertion on modified date |
| packages/atlas-service/src/secret-store.ts | Replace UserData with FileUserData |
Comments suppressed due to low confidence (1)
packages/my-queries-storage/src/compass-query-storage.ts:77
- [nitpick] The comment refers to writing to "system/db", but this implementation writes to the file system. Update the comment to accurately reflect file-based storage.
// this creates a recent query that we will write to system/db
mabaasit
reviewed
Jul 10, 2025
packages/compass-data-modeling/src/components/diagram-card.spec.tsx
Outdated
Show resolved
Hide resolved
Merge branch 'user-data-interface' of https://github.com/mongodb-js/compass into user-data-interface
mabaasit
approved these changes
Jul 10, 2025
gribnoysup
reviewed
Jul 14, 2025
|
|
||
| export type UserDataOptions<Input> = { | ||
| export type FileUserDataOptions<Input> = { | ||
| subdir: string; |
Collaborator
There was a problem hiding this comment.
The naming on this one is unfortunate, but I think it's also relevant for the shared userdata interface
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refactoring the existing UserData class as an abstract class, and extending the abstract class as FileUserData. This is in preparation for the saving user data project for Data Explorer, where we will extend the abstract class as AtlasUserData.
Checklist
Motivation and Context
Open Questions
Dependents
Types of changes